﻿/**
 * The AudioTrack Library by Chris J. Rock. Aug 10, 2011
 * Check out chrisjrock.net and be a king among men.
 *
 * Copyright (c) 2011 Chris J. Rock
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 **/


package net.chrisjrock.sound.audioTrack.events 
{
	import flash.events.Event;
	
	import net.chrisjrock.sound.audioTrack.track.IAudioTrack;
	
	/**
	 * Used for all mixer events.
	 * @author Christopher J. Rock
	 */
	public class AudioMixerEvent extends Event 
	{
		public static const REMOVE_TRACK:String = "mixerRemoveTrack";
		public static const SOLO_TOGGLE:String = "mixerSoloToggle";
		public static const UPDATE:String = "mixerUpdate";
		
		protected var _track:IAudioTrack;
		
		public function AudioMixerEvent(type:String , track:IAudioTrack = null , bubbles:Boolean = false , cancelable:Boolean = false) 
		{
			_track = track;
			super(type , bubbles , cancelable);
		}
		
		/**
		 * Returns a duplicate object.
		 * @return 
		 */		
		public override function clone():Event
		{
			return new AudioMixerEvent(type , _track , bubbles , cancelable);
		}
		
		public override function toString():String
		{
			return formatToString("AudioMixerEvent", "type", "track", "bubbles", "cancelable", "eventPhase");
		}
		
		/**
		 * Returns the track from which the event originated (for event bubbling).
		 * @return 
		 */
		public function get track ():IAudioTrack
		{
			return _track;
		}
	}
	
}